/*
 * Copyright (C) 2009-2011 Knowings
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 3
 * as published by the Free Software Foundation.
 *

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package com.knowings.tbs.operation;

import java.util.List;

import com.knowings.tbs.persistence.IPersistent;

/**
 * Parent interface for queries and transformations. 
 * 
 * @author privarola
 */
public interface IOperation extends IPersistent {

  /**
   * Method returning the language property of the described operation.
   * @return a String object representing the language. It shouldn't be null or empty.
   */
  public String getLanguage();

  /**
   * Method returning the expression of the operation as a text in the operation language.
   * @return a String defining the operation in its language.
   */
  public String getDefinition();
  
  /**
   * Method returning the definition of parameters that can be specified at runtime to run this operation.
   * Parameters with a default value are supposed optional. Those without default value will be mandatory.
   * @return a list of <code>IParamDef</code> instances to be given at runtime
   */
  public List<IParamDef> getParameters();
  
  /**
   * Boolean indicator to tell if this operation is monotonous, and thus can be executed
   * in an incremental way.
   * @return true if this operation should be considered as monotonous.
   */
  public boolean isMonotonous();
}
